<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>v_voip_depacketizer56: xdepacketizer56.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.gif"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">v_voip_depacketizer56
   </div>
   <div id="projectbrief">Xilinx SDK Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xdepacketizer56_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a>  </div>
  <div class="headertitle">
<div class="title">xdepacketizer56.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This is the main header file for VoIP ST2022-6 Depacketizer core. </p>
<p>VoIP ST2022-6 Depacketizer core is used to map Incoming ST2022-5 RTP Packet in to SDI to AXI4-Stream Packet.</p>
<p>The VoIP ST2022-6 Depacketizer has 3 main Interface</p><ul>
<li>AXI4-Stream Interface for accepting Incoming SDI to AXI4-Stream Packet</li>
<li>AXI4-Stream Interface for transmitting RTP Packet &lt;RTP Header | Payload&gt;</li>
<li>AXI4-Lite interface for processor, controls the VoIP ST2022-6 Depacketizer.</li>
</ul>
<p>VoIP ST2022-6 Depacketizer Performs Following Operation</p><ul>
<li>Map/Convert ST2022-5 RTP Packet in to SDI to AXI4-Stream Packet</li>
</ul>
<p><b>Software Initialization &amp; Configuration</b></p>
<p>The application needs to do following steps in order for preparing the VoIP ST2022-6 Depacketizer core to be ready.</p>
<ul>
<li>Call XDepacketizer56_LookupConfig using a device ID to find the core configuration.</li>
<li>Call XDepacketizer56_CfgInitialize to initialize the device and the driver instance associated with it.</li>
</ul>
<p>This driver provides interrupt handlers</p><ul>
<li>XDepacketizer56_IntrHandler, for handling the interrupts from the VoIP ST2022-6 Depacketizer core</li>
</ul>
<p>Application developer needs to register interrupt handler with the processor, within their examples. Whenever processor calls registered application's interrupt handler associated with interrupt id, application's interrupt handler needs to call appropriate peripheral interrupt handler reading peripherals Status register.</p>
<p>This driver provides XDepacketizer56_SetCallback API to register functions with VoIP ST2022-6 Depacketizer core instance.</p>
<p><b> Virtual Memory </b></p>
<p><b> Threads </b></p>
<p><b> Asserts </b></p>
<p><b> Building the driver </b></p>
<p>The VoIP ST2022-6 Depacketizer driver is composed of several source files. This allows the user to build and link only those parts of the driver that are necessary.</p>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who    Date     Changes
<hr/>

1.00   mmo   02/12/16 Initial release.</pre><pre></pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_depacketizer56___config.html">XDepacketizer56_Config</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">This typedef contains configuration information for the VoIP ST2022-6 Depacketizer core.  <a href="struct_x_depacketizer56___config.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_depacketizer56___stream.html">XDepacketizer56_Stream</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">This typedef contains Incoming SDI to AXI4-Stream Information.  <a href="struct_x_depacketizer56___stream.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_depacketizer56___module_statistic.html">XDepacketizer56_ModuleStatistic</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">This typedef contains Incoming Packet Count, Outgoing Frame Count Information, Current Buffer Level and Observed Peak Buffer Level.  <a href="struct_x_depacketizer56___module_statistic.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_depacketizer56___module_status.html">XDepacketizer56_ModuleStatus</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">This typedef contains the Module Status Component.  <a href="struct_x_depacketizer56___module_status.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_depacketizer56.html">XDepacketizer56</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The VoIP ST2022-6 Depacketizer driver instance data.  <a href="struct_x_depacketizer56.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a9d4718cd44294c06fda732181fe599e2"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdepacketizer56_8h.html#a9d4718cd44294c06fda732181fe599e2">XDEPACKETIZER56_H_</a></td></tr>
<tr class="memdesc:a9d4718cd44294c06fda732181fe599e2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent circular inclusions by using protection macros.  <a href="#a9d4718cd44294c06fda732181fe599e2">More...</a><br /></td></tr>
<tr class="separator:a9d4718cd44294c06fda732181fe599e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Handler Types</div></td></tr>
<tr class="memitem:adf6e710bc312777e4d35572e147392e2"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdepacketizer56_8h.html#adf6e710bc312777e4d35572e147392e2">XDepacketizer56_HandlerType</a> <tr class="memdesc:adf6e710bc312777e4d35572e147392e2"><td class="mdescLeft">&#160;</td><td class="mdescRight">These constants specify different types of handler and used to differentiate interrupt requests from peripheral.  <a href="xdepacketizer56_8h.html#adf6e710bc312777e4d35572e147392e2">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:adf6e710bc312777e4d35572e147392e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Timestamp Reference (Video Header)</div></td></tr>
<tr class="memitem:acdc1c5b7845255ae82246d4e373dff64"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdepacketizer56_8h.html#acdc1c5b7845255ae82246d4e373dff64">XDepacketizer56_TimestampRef</a> <tr class="memdesc:acdc1c5b7845255ae82246d4e373dff64"><td class="mdescLeft">&#160;</td><td class="mdescRight">These constants specify the VoIP ST2022-6 Depacketizer Timestamp Reference in the Video Header.  <a href="xdepacketizer56_8h.html#acdc1c5b7845255ae82246d4e373dff64">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:acdc1c5b7845255ae82246d4e373dff64"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Video Bit Rate</div></td></tr>
<tr class="memitem:ae960718b3462f9aea19db0b5ddef6efd"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdepacketizer56_8h.html#ae960718b3462f9aea19db0b5ddef6efd">XDepacketizer56_RXBITRATE</a> <tr class="memdesc:ae960718b3462f9aea19db0b5ddef6efd"><td class="mdescLeft">&#160;</td><td class="mdescRight">These constants specify the VoIP ST2022-6 Depacketizer Video Bit Rate either is an Integer (148.5 MHz or 74.25 MHz) or Non-Integer (148.35 MHz or 74.175 MHz)  <a href="xdepacketizer56_8h.html#ae960718b3462f9aea19db0b5ddef6efd">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:ae960718b3462f9aea19db0b5ddef6efd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">3G-SDI Level</div></td></tr>
<tr class="memitem:a41bd0d74106ba52dc8bec6f852f97f92"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdepacketizer56_8h.html#a41bd0d74106ba52dc8bec6f852f97f92">XDepacketizer56_3G_LEVEL</a> <tr class="memdesc:a41bd0d74106ba52dc8bec6f852f97f92"><td class="mdescLeft">&#160;</td><td class="mdescRight">These constants specify the VoIP ST2022-6 Depacketizer Incoming ST2022-6 RTP Packet is a SDI-3G Level A or Level B.  <a href="xdepacketizer56_8h.html#a41bd0d74106ba52dc8bec6f852f97f92">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a41bd0d74106ba52dc8bec6f852f97f92"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">SDI Mode</div></td></tr>
<tr class="memitem:a78ee94aa71d1cf9b1667d313b85b2cb8"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdepacketizer56_8h.html#a78ee94aa71d1cf9b1667d313b85b2cb8">XDepacketizer56_SDIMode</a> <tr class="memdesc:a78ee94aa71d1cf9b1667d313b85b2cb8"><td class="mdescLeft">&#160;</td><td class="mdescRight">These constants specify the VoIP ST2022-6 Depacketizer Incoming ST2022-6 RTP Packet is, SD-SDI or HD-SDI or 3G-SDI.  <a href="xdepacketizer56_8h.html#a78ee94aa71d1cf9b1667d313b85b2cb8">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a78ee94aa71d1cf9b1667d313b85b2cb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Frame Config</div></td></tr>
<tr class="memitem:a03ac588bc763cbf7195bacbb9772db7d"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdepacketizer56_8h.html#a03ac588bc763cbf7195bacbb9772db7d">XDepacketizer56_FrameCfg</a> <tr class="memdesc:a03ac588bc763cbf7195bacbb9772db7d"><td class="mdescLeft">&#160;</td><td class="mdescRight">These constants specify the VoIP ST2022-6 Depacketizer to obtained incoming ST2022-6 RTP Packet Frame Information either from TUSER Slave AXI4-Stream of VoIP ST2022-6 Depacketizer or User Configure Register.  <a href="xdepacketizer56_8h.html#a03ac588bc763cbf7195bacbb9772db7d">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a03ac588bc763cbf7195bacbb9772db7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
ST2022-6 Depacketizer Module Enable/Disable</h2></td></tr>
<tr class="memitem:ae7c3fdc3e1b11f3d5b5f47ccf7d44231"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdepacketizer56_8h.html#ae7c3fdc3e1b11f3d5b5f47ccf7d44231">XDepacketizer56_ModEn</a> <tr class="memdesc:ae7c3fdc3e1b11f3d5b5f47ccf7d44231"><td class="mdescLeft">&#160;</td><td class="mdescRight">These constants specify the VoIP ST2022-6 Depacketizer Module Enable or Disable.  <a href="xdepacketizer56_8h.html#ae7c3fdc3e1b11f3d5b5f47ccf7d44231">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:ae7c3fdc3e1b11f3d5b5f47ccf7d44231"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a194c71d73b43bb381b5396f101889b0c"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdepacketizer56_8h.html#a194c71d73b43bb381b5396f101889b0c">XDepacketizer56_Callback</a>) (void *CallbackRef)</td></tr>
<tr class="memdesc:a194c71d73b43bb381b5396f101889b0c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback type for VoIP ST2022-6 Depacketizer event interrupt.  <a href="#a194c71d73b43bb381b5396f101889b0c">More...</a><br /></td></tr>
<tr class="separator:a194c71d73b43bb381b5396f101889b0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae867968b48fa935f992a3711b35a19ee"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_depacketizer56___config.html">XDepacketizer56_Config</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdepacketizer56_8h.html#ae867968b48fa935f992a3711b35a19ee">XDepacketizer56_LookupConfig</a> (u16 DeviceId)</td></tr>
<tr class="memdesc:ae867968b48fa935f992a3711b35a19ee"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns a reference to an <a class="el" href="struct_x_depacketizer56___config.html" title="This typedef contains configuration information for the VoIP ST2022-6 Depacketizer core...">XDepacketizer56_Config</a> structure based on the core id, <em>DeviceId</em>.  <a href="#ae867968b48fa935f992a3711b35a19ee">More...</a><br /></td></tr>
<tr class="separator:ae867968b48fa935f992a3711b35a19ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adb103b4062e7d0ebcefd751302c3c909"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdepacketizer56_8h.html#adb103b4062e7d0ebcefd751302c3c909">XDepacketizer56_CfgInitialize</a> (<a class="el" href="struct_x_depacketizer56.html">XDepacketizer56</a> *InstancePtr, <a class="el" href="struct_x_depacketizer56___config.html">XDepacketizer56_Config</a> *CfgPtr, UINTPTR EffectiveAddr)</td></tr>
<tr class="memdesc:adb103b4062e7d0ebcefd751302c3c909"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function initializes the VoIP ST2022-6 Depacketizer core.  <a href="#adb103b4062e7d0ebcefd751302c3c909">More...</a><br /></td></tr>
<tr class="separator:adb103b4062e7d0ebcefd751302c3c909"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a786a8230431f4220e413b0a57249f423"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_depacketizer56___module_status.html">XDepacketizer56_ModuleStatus</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdepacketizer56_8h.html#a786a8230431f4220e413b0a57249f423">XDepacketizer56_ErroStatus</a> (<a class="el" href="struct_x_depacketizer56.html">XDepacketizer56</a> *InstancePtr)</td></tr>
<tr class="memdesc:a786a8230431f4220e413b0a57249f423"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function obtains the current Module Status of ST2022-6 Depacketizer Module.  <a href="#a786a8230431f4220e413b0a57249f423">More...</a><br /></td></tr>
<tr class="separator:a786a8230431f4220e413b0a57249f423"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9338e04e951eec7800cb0bdb801c2d0f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdepacketizer56_8h.html#a9338e04e951eec7800cb0bdb801c2d0f">XDepacketizer56_IntrHandler</a> (void *InstancePtr)</td></tr>
<tr class="memdesc:a9338e04e951eec7800cb0bdb801c2d0f"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is the interrupt handler for the VoIP ST2022-6 Depacketizer driver.  <a href="#a9338e04e951eec7800cb0bdb801c2d0f">More...</a><br /></td></tr>
<tr class="separator:a9338e04e951eec7800cb0bdb801c2d0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a35c884f97699cb6a31ffbba8e5cdcbe6"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdepacketizer56_8h.html#a35c884f97699cb6a31ffbba8e5cdcbe6">XDepacketizer56_SetCallback</a> (<a class="el" href="struct_x_depacketizer56.html">XDepacketizer56</a> *InstancePtr, <a class="el" href="xdepacketizer56_8h.html#adf6e710bc312777e4d35572e147392e2">XDepacketizer56_HandlerType</a> HandlerType, void *CallbackFunc, void *CallbackRef)</td></tr>
<tr class="memdesc:a35c884f97699cb6a31ffbba8e5cdcbe6"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function installs an asynchronous callback function for the given HandlerType:  <a href="#a35c884f97699cb6a31ffbba8e5cdcbe6">More...</a><br /></td></tr>
<tr class="separator:a35c884f97699cb6a31ffbba8e5cdcbe6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac227b722fc7db1657eee18ee6c112016"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_depacketizer56___module_statistic.html">XDepacketizer56_ModuleStatistic</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdepacketizer56_8h.html#ac227b722fc7db1657eee18ee6c112016">XDepacketizer56_ModuleStatisticRegValue</a> (<a class="el" href="struct_x_depacketizer56.html">XDepacketizer56</a> *InstancePtr)</td></tr>
<tr class="memdesc:ac227b722fc7db1657eee18ee6c112016"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function obtained the current statistic of the ST2022-6 Depacketizer.  <a href="#ac227b722fc7db1657eee18ee6c112016">More...</a><br /></td></tr>
<tr class="separator:ac227b722fc7db1657eee18ee6c112016"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa02baacd756caef0af4a34a58f0e046b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdepacketizer56_8h.html#aa02baacd756caef0af4a34a58f0e046b">XDepacketizer56_ModEnable</a> (<a class="el" href="struct_x_depacketizer56.html">XDepacketizer56</a> *InstancePtr)</td></tr>
<tr class="memdesc:aa02baacd756caef0af4a34a58f0e046b"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function perform Module Enable/Disable the ST2022-6 Depacketizer Module.  <a href="#aa02baacd756caef0af4a34a58f0e046b">More...</a><br /></td></tr>
<tr class="separator:aa02baacd756caef0af4a34a58f0e046b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a08eeb035b57cfc5edd659ea504904372"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdepacketizer56_8h.html#a08eeb035b57cfc5edd659ea504904372">XDepacketizer56_RegClear</a> (<a class="el" href="struct_x_depacketizer56.html">XDepacketizer56</a> *InstancePtr)</td></tr>
<tr class="memdesc:a08eeb035b57cfc5edd659ea504904372"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function perforemed software reset or Register Clear on the ST2022-6 Depacketizer Module.  <a href="#a08eeb035b57cfc5edd659ea504904372">More...</a><br /></td></tr>
<tr class="separator:a08eeb035b57cfc5edd659ea504904372"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a332955bdbd284e9f8eeac181036abfac"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdepacketizer56_8h.html#a332955bdbd284e9f8eeac181036abfac">XDepacketizer56_VidFormat</a> (<a class="el" href="struct_x_depacketizer56.html">XDepacketizer56</a> *InstancePtr)</td></tr>
<tr class="memdesc:a332955bdbd284e9f8eeac181036abfac"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function configures the Video Information in to the ST2022-6 Depacketizer Module.  <a href="#a332955bdbd284e9f8eeac181036abfac">More...</a><br /></td></tr>
<tr class="separator:a332955bdbd284e9f8eeac181036abfac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a11872599d7de6421f987c54dca962a11"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdepacketizer56_8h.html#a11872599d7de6421f987c54dca962a11">XDepacketizer56_RTPMediaHeader</a> (<a class="el" href="struct_x_depacketizer56.html">XDepacketizer56</a> *InstancePtr)</td></tr>
<tr class="memdesc:a11872599d7de6421f987c54dca962a11"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function configures the RTP Media Header/ST2022-6 Header into ST2022-6 Depacketizer Module.  <a href="#a11872599d7de6421f987c54dca962a11">More...</a><br /></td></tr>
<tr class="separator:a11872599d7de6421f987c54dca962a11"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef6a9e80f95fb13b4f6a803aba746e82"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdepacketizer56_8h.html#aef6a9e80f95fb13b4f6a803aba746e82">XDepacketizer56_ResetStatistic</a> (<a class="el" href="struct_x_depacketizer56.html">XDepacketizer56</a> *InstancePtr)</td></tr>
<tr class="memdesc:aef6a9e80f95fb13b4f6a803aba746e82"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function perform Module Statistic reset of ST2022-6 Depacketizer Module.  <a href="#aef6a9e80f95fb13b4f6a803aba746e82">More...</a><br /></td></tr>
<tr class="separator:aef6a9e80f95fb13b4f6a803aba746e82"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a9d4718cd44294c06fda732181fe599e2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9d4718cd44294c06fda732181fe599e2">&#9670;&nbsp;</a></span>XDEPACKETIZER56_H_</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XDEPACKETIZER56_H_</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Prevent circular inclusions by using protection macros. </p>

</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="a194c71d73b43bb381b5396f101889b0c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a194c71d73b43bb381b5396f101889b0c">&#9670;&nbsp;</a></span>XDepacketizer56_Callback</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef void(* XDepacketizer56_Callback) (void *CallbackRef)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Callback type for VoIP ST2022-6 Depacketizer event interrupt. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">CallbackRef</td><td>is a callback reference passed in by the upper layer when setting the callback functions, and passed back to the upper layer when the callback is invoked.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a41bd0d74106ba52dc8bec6f852f97f92"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a41bd0d74106ba52dc8bec6f852f97f92">&#9670;&nbsp;</a></span>XDepacketizer56_3G_LEVEL</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="xdepacketizer56_8h.html#a41bd0d74106ba52dc8bec6f852f97f92">XDepacketizer56_3G_LEVEL</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>These constants specify the VoIP ST2022-6 Depacketizer Incoming ST2022-6 RTP Packet is a SDI-3G Level A or Level B. </p>

</div>
</div>
<a id="a03ac588bc763cbf7195bacbb9772db7d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a03ac588bc763cbf7195bacbb9772db7d">&#9670;&nbsp;</a></span>XDepacketizer56_FrameCfg</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="xdepacketizer56_8h.html#a03ac588bc763cbf7195bacbb9772db7d">XDepacketizer56_FrameCfg</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>These constants specify the VoIP ST2022-6 Depacketizer to obtained incoming ST2022-6 RTP Packet Frame Information either from TUSER Slave AXI4-Stream of VoIP ST2022-6 Depacketizer or User Configure Register. </p>

</div>
</div>
<a id="adf6e710bc312777e4d35572e147392e2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adf6e710bc312777e4d35572e147392e2">&#9670;&nbsp;</a></span>XDepacketizer56_HandlerType</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="xdepacketizer56_8h.html#adf6e710bc312777e4d35572e147392e2">XDepacketizer56_HandlerType</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>These constants specify different types of handler and used to differentiate interrupt requests from peripheral. </p>

</div>
</div>
<a id="ae7c3fdc3e1b11f3d5b5f47ccf7d44231"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae7c3fdc3e1b11f3d5b5f47ccf7d44231">&#9670;&nbsp;</a></span>XDepacketizer56_ModEn</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="xdepacketizer56_8h.html#ae7c3fdc3e1b11f3d5b5f47ccf7d44231">XDepacketizer56_ModEn</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>These constants specify the VoIP ST2022-6 Depacketizer Module Enable or Disable. </p>

</div>
</div>
<a id="ae960718b3462f9aea19db0b5ddef6efd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae960718b3462f9aea19db0b5ddef6efd">&#9670;&nbsp;</a></span>XDepacketizer56_RXBITRATE</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="xdepacketizer56_8h.html#ae960718b3462f9aea19db0b5ddef6efd">XDepacketizer56_RXBITRATE</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>These constants specify the VoIP ST2022-6 Depacketizer Video Bit Rate either is an Integer (148.5 MHz or 74.25 MHz) or Non-Integer (148.35 MHz or 74.175 MHz) </p>

</div>
</div>
<a id="a78ee94aa71d1cf9b1667d313b85b2cb8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a78ee94aa71d1cf9b1667d313b85b2cb8">&#9670;&nbsp;</a></span>XDepacketizer56_SDIMode</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="xdepacketizer56_8h.html#a78ee94aa71d1cf9b1667d313b85b2cb8">XDepacketizer56_SDIMode</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>These constants specify the VoIP ST2022-6 Depacketizer Incoming ST2022-6 RTP Packet is, SD-SDI or HD-SDI or 3G-SDI. </p>

</div>
</div>
<a id="acdc1c5b7845255ae82246d4e373dff64"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acdc1c5b7845255ae82246d4e373dff64">&#9670;&nbsp;</a></span>XDepacketizer56_TimestampRef</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="xdepacketizer56_8h.html#acdc1c5b7845255ae82246d4e373dff64">XDepacketizer56_TimestampRef</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>These constants specify the VoIP ST2022-6 Depacketizer Timestamp Reference in the Video Header. </p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="adb103b4062e7d0ebcefd751302c3c909"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adb103b4062e7d0ebcefd751302c3c909">&#9670;&nbsp;</a></span>XDepacketizer56_CfgInitialize()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XDepacketizer56_CfgInitialize </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_depacketizer56.html">XDepacketizer56</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_depacketizer56___config.html">XDepacketizer56_Config</a> *&#160;</td>
          <td class="paramname"><em>CfgPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">UINTPTR&#160;</td>
          <td class="paramname"><em>EffectiveAddr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function initializes the VoIP ST2022-6 Depacketizer core. </p>
<p>This function must be called prior to using the VoIP ST2022-6 Depacketizer core. Initialization of the VoIP ST2022-6 Depacketizer includes setting up the instance data, and ensuring the hardware is in a quiescent state.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the VoIP ST2022-6 Depacketizer core instance. </td></tr>
    <tr><td class="paramname">CfgPtr</td><td>points to the configuration structure associated with the VoIP ST2022-6 Depacketizer core. </td></tr>
    <tr><td class="paramname">EffectiveAddr</td><td>is the base address of the device. If address translation is being used, then this parameter must reflect the virtual base address. Otherwise, the physical address should be used.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if XDepacketizer56_CfgInitialize was successful.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="struct_x_depacketizer56.html#a79e1163020b314523fc75c2c511de15b">XDepacketizer56::DatagramMismatchCallback</a>, <a class="el" href="struct_x_depacketizer56.html#ac17a827fb71d53ed30f2a760d5c1002a">XDepacketizer56::IsDatagramMismatchCallbackSet</a>, and <a class="el" href="xdepacketizer56_8h.html#a08eeb035b57cfc5edd659ea504904372">XDepacketizer56_RegClear()</a>.</p>

</div>
</div>
<a id="a786a8230431f4220e413b0a57249f423"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a786a8230431f4220e413b0a57249f423">&#9670;&nbsp;</a></span>XDepacketizer56_ErroStatus()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_x_depacketizer56___module_status.html">XDepacketizer56_ModuleStatus</a> XDepacketizer56_ErroStatus </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_depacketizer56.html">XDepacketizer56</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function obtains the current Module Status of ST2022-6 Depacketizer Module. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_depacketizer56.html" title="The VoIP ST2022-6 Depacketizer driver instance data. ">XDepacketizer56</a> core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XDepacketizer56_ModuleStatistic_RegValue.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="xdepacketizer56__hw_8h.html#a0c9e147b7ea636be77c5d2239cd1cb75">XDepacketizer56_ReadReg</a>.</p>

</div>
</div>
<a id="a9338e04e951eec7800cb0bdb801c2d0f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9338e04e951eec7800cb0bdb801c2d0f">&#9670;&nbsp;</a></span>XDepacketizer56_IntrHandler()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XDepacketizer56_IntrHandler </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is the interrupt handler for the VoIP ST2022-6 Depacketizer driver. </p>
<p>This handler reads the pending interrupt from VoIP ST2022-6 Depacketizer, determines the source of the interrupts, clears the interrupts and calls callbacks accordingly.</p>
<p>The application is responsible for connecting this function to the interrupt system. Application beyond this driver is also responsible for providing callbacks to handle interrupts and installing the callbacks using <a class="el" href="xdepacketizer56__intr_8c.html#a35c884f97699cb6a31ffbba8e5cdcbe6" title="This function installs an asynchronous callback function for the given HandlerType: ...">XDepacketizer56_SetCallback()</a> during initialization phase. An example delivered with this driver demonstrates how this could be done.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_depacketizer56.html" title="The VoIP ST2022-6 Depacketizer driver instance data. ">XDepacketizer56</a> instance that just interrupted.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="xdepacketizer56__hw_8h.html#a0c9e147b7ea636be77c5d2239cd1cb75">XDepacketizer56_ReadReg</a>.</p>

</div>
</div>
<a id="ae867968b48fa935f992a3711b35a19ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae867968b48fa935f992a3711b35a19ee">&#9670;&nbsp;</a></span>XDepacketizer56_LookupConfig()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_x_depacketizer56___config.html">XDepacketizer56_Config</a>* XDepacketizer56_LookupConfig </td>
          <td>(</td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>DeviceId</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function returns a reference to an <a class="el" href="struct_x_depacketizer56___config.html" title="This typedef contains configuration information for the VoIP ST2022-6 Depacketizer core...">XDepacketizer56_Config</a> structure based on the core id, <em>DeviceId</em>. </p>
<p>The return value will refer to an entry in the device configuration table defined in the xdepacketizer56_g.c file.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">DeviceId</td><td>is the unique core ID of the VoIP Decapsulator core for the lookup operation.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XDepacketizer56_LookupConfig returns a reference to a config record in the configuration table (in xdepacketizer56_g.c) corresponding to <em>DeviceId</em>, or NULL if no match is found.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

</div>
</div>
<a id="aa02baacd756caef0af4a34a58f0e046b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa02baacd756caef0af4a34a58f0e046b">&#9670;&nbsp;</a></span>XDepacketizer56_ModEnable()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XDepacketizer56_ModEnable </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_depacketizer56.html">XDepacketizer56</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function perform Module Enable/Disable the ST2022-6 Depacketizer Module. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_depacketizer56.html" title="The VoIP ST2022-6 Depacketizer driver instance data. ">XDepacketizer56</a> core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XDepacketizer56_ModuleStatistic_RegValue.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="xdepacketizer56__hw_8h.html#a0c9e147b7ea636be77c5d2239cd1cb75">XDepacketizer56_ReadReg</a>.</p>

</div>
</div>
<a id="ac227b722fc7db1657eee18ee6c112016"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac227b722fc7db1657eee18ee6c112016">&#9670;&nbsp;</a></span>XDepacketizer56_ModuleStatisticRegValue()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_x_depacketizer56___module_statistic.html">XDepacketizer56_ModuleStatistic</a> XDepacketizer56_ModuleStatisticRegValue </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_depacketizer56.html">XDepacketizer56</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function obtained the current statistic of the ST2022-6 Depacketizer. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_depacketizer56.html" title="The VoIP ST2022-6 Depacketizer driver instance data. ">XDepacketizer56</a> core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XDepacketizer56_ModuleStatistic_RegValue.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="xdepacketizer56__hw_8h.html#a0c9e147b7ea636be77c5d2239cd1cb75">XDepacketizer56_ReadReg</a>.</p>

</div>
</div>
<a id="a08eeb035b57cfc5edd659ea504904372"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a08eeb035b57cfc5edd659ea504904372">&#9670;&nbsp;</a></span>XDepacketizer56_RegClear()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XDepacketizer56_RegClear </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_depacketizer56.html">XDepacketizer56</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function perforemed software reset or Register Clear on the ST2022-6 Depacketizer Module. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_depacketizer56.html" title="The VoIP ST2022-6 Depacketizer driver instance data. ">XDepacketizer56</a> core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XDepacketizer56_ModuleStatistic_RegValue.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="xdepacketizer56__hw_8h.html#a0c9e147b7ea636be77c5d2239cd1cb75">XDepacketizer56_ReadReg</a>.</p>

<p class="reference">Referenced by <a class="el" href="xdepacketizer56_8h.html#adb103b4062e7d0ebcefd751302c3c909">XDepacketizer56_CfgInitialize()</a>.</p>

</div>
</div>
<a id="aef6a9e80f95fb13b4f6a803aba746e82"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aef6a9e80f95fb13b4f6a803aba746e82">&#9670;&nbsp;</a></span>XDepacketizer56_ResetStatistic()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XDepacketizer56_ResetStatistic </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_depacketizer56.html">XDepacketizer56</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function perform Module Statistic reset of ST2022-6 Depacketizer Module. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_depacketizer56.html" title="The VoIP ST2022-6 Depacketizer driver instance data. ">XDepacketizer56</a> core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XDepacketizer56_ModuleStatistic_RegValue.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="xdepacketizer56__hw_8h.html#adef55a6f76557c6aa4b2864f9fef8b1b">XDepacketizer56_WriteReg</a>.</p>

</div>
</div>
<a id="a11872599d7de6421f987c54dca962a11"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a11872599d7de6421f987c54dca962a11">&#9670;&nbsp;</a></span>XDepacketizer56_RTPMediaHeader()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XDepacketizer56_RTPMediaHeader </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_depacketizer56.html">XDepacketizer56</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function configures the RTP Media Header/ST2022-6 Header into ST2022-6 Depacketizer Module. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_depacketizer56.html" title="The VoIP ST2022-6 Depacketizer driver instance data. ">XDepacketizer56</a> core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XDepacketizer56_ModuleStatistic_RegValue.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="xdepacketizer56__hw_8h.html#a0c9e147b7ea636be77c5d2239cd1cb75">XDepacketizer56_ReadReg</a>.</p>

</div>
</div>
<a id="a35c884f97699cb6a31ffbba8e5cdcbe6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a35c884f97699cb6a31ffbba8e5cdcbe6">&#9670;&nbsp;</a></span>XDepacketizer56_SetCallback()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XDepacketizer56_SetCallback </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_depacketizer56.html">XDepacketizer56</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="xdepacketizer56_8h.html#adf6e710bc312777e4d35572e147392e2">XDepacketizer56_HandlerType</a>&#160;</td>
          <td class="paramname"><em>HandlerType</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>CallbackFunc</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>CallbackRef</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function installs an asynchronous callback function for the given HandlerType: </p>
<pre>
HandlerType                 Callback Function Type
-------------------------   -----------------------------------------------
</pre><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the VoIP ST2022-6 Depacketizer core instance. </td></tr>
    <tr><td class="paramname">HandlerType</td><td>specifies the type of handler. </td></tr>
    <tr><td class="paramname">CallbackFunc</td><td>is the address of the callback function. </td></tr>
    <tr><td class="paramname">CallbackRef</td><td>is a user data item that will be passed to the callback function when it is invoked.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if callback function installed successfully.</li>
<li>XST_INVALID_PARAM when HandlerType is invalid.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Invoking this function for a handler that already has been installed replaces it with the new handler. </dd></dl>

</div>
</div>
<a id="a332955bdbd284e9f8eeac181036abfac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a332955bdbd284e9f8eeac181036abfac">&#9670;&nbsp;</a></span>XDepacketizer56_VidFormat()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XDepacketizer56_VidFormat </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_depacketizer56.html">XDepacketizer56</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function configures the Video Information in to the ST2022-6 Depacketizer Module. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_depacketizer56.html" title="The VoIP ST2022-6 Depacketizer driver instance data. ">XDepacketizer56</a> core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XDepacketizer56_ModuleStatistic_RegValue.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="xdepacketizer56__hw_8h.html#a0c9e147b7ea636be77c5d2239cd1cb75">XDepacketizer56_ReadReg</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Copyright &copy; 2015 Xilinx Inc. All rights reserved.</li>
  </ul>
</div>
</body>
</html>
